home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / grafik / bildanzeiger / superview-lib_dev / docs / svoperator_ref_eng.doc < prev    next >
Text File  |  1995-03-09  |  4KB  |  170 lines
  1.  
  2.    $VER: SVOperator_Ref_ENG.doc V1.1 (30.9.94)
  3.  
  4.    © 1994 by Andreas R. Kleinert. All rights reserved.
  5.  
  6.    - Feel free to translate this Doc-File into other languages. -
  7.  
  8.           Andreas R. Kleinert,
  9.           Grube Hohe Grethe 23,
  10.           D-57074 Siegen,
  11.           Germany.
  12.  
  13.     Phone:  +49-271-331859 (weekdays after 18.00h)
  14.             +49-271-332147 (weekdays after 18.00h)
  15.     EMail:  Fido             Andreas Kleinert 2:2457/345.10
  16.             Usenet/InterNet  Andreas_Kleinert@superview.ftn.sub.org
  17.  
  18.       If nothing else works, try one of these Fido-InterNet gateways:
  19.  
  20.             Andreas_Kleinert@p10.f345.n2457.z2.fido.sub.org (Germany)
  21.             Andreas_Kleinert@p10.f345.n2457.z2.fidonet.org  (US)
  22.  
  23.  
  24.    * DO _NEVER_ ACCESS ANY SVOPERATORS DIRECTLY.
  25.    * DO NEVER BYPASS superview.library !
  26.  
  27.    THE FOLLOWING NOTES ARE ONLY FOR PROGRAMMERS OF SVOPERATORS :
  28.  
  29.    Here is a listing of the function set, which any of the version 1
  30.    SVOperators does contain, in an Autodoc-like style of description :
  31.  
  32.         SVP_AllocHandle            ; since Version 1
  33.         SVP_FreeHandle
  34.         SVP_DoOperation
  35.  
  36.  (you will never find any notes belonging to "BUGS", because any SVOperator
  37.   may have its own ...)
  38.  
  39. -----------------------------------------------------------------------------
  40.    Functions available since Version 1 :
  41. -----------------------------------------------------------------------------
  42.  
  43.    NAME
  44.         SVP_AllocHandle
  45.  
  46.    SYNOPSIS
  47.  
  48.         APTR SVP_AllocHandle(APTR future)
  49.         D0   -$1e            A1
  50.  
  51.    FUNCTION
  52.  
  53.         Allocates a handle for handling a GfxBuffer via this SVOperator.
  54.  
  55.    INPUT(S)
  56.  
  57.         future - always NULL yet
  58.  
  59.    RESULT
  60.  
  61.         A pointer to a new allocated Handle or NULL, if allocation failed.
  62.  
  63.    WARNING
  64.  
  65.         Test, if the result was NULL, or not !
  66.  
  67.    SINCE
  68.  
  69.         ... Version 1 SVOperators.
  70.  
  71.    SEE ALSO
  72.  
  73.         SVP_FreeHandle
  74.  
  75. -----------------------------------------------------------------------------
  76.  
  77.    NAME
  78.         SVP_FreeHandle
  79.  
  80.    SYNOPSIS
  81.  
  82.         VOID SVP_FreeHandle(APTR handle)
  83.         D0   -$24           A1
  84.  
  85.    FUNCTION
  86.  
  87.        Aborts showing, frees all Resources and delocates a Handle, which has
  88.        been allocated with SVP_AllocHandle before.
  89.  
  90.  
  91.        For programmers of SVDrivers :
  92.  
  93.        Note, that this function should call
  94.  
  95.           SVP_CloseDisplay(SVHandle);
  96.           SVP_FreeResources(SVHandle);
  97.  
  98.        internally always. Otherwise memory might be lost, because
  99.        superview.library might only make a call to SVO_FreeHandle(),
  100.        without closing the display/freeing the resources before.
  101.  
  102.    INPUT(S)
  103.  
  104.         handle - a valid handle
  105.  
  106.    RESULT
  107.  
  108.         -
  109.  
  110.    SINCE
  111.  
  112.         ... Version 1 SVOperators.
  113.  
  114.    SEE ALSO
  115.  
  116.         SVP_AllocHandle, SVP_DoOperation
  117.  
  118. -----------------------------------------------------------------------------
  119.  
  120.  
  121.    NAME
  122.         SVP_DoOperation
  123.  
  124.    SYNOPSIS
  125.  
  126.         ULONG SVP_DoOperation(APTR handle, struct SV_GfxBuffer *source,
  127.         D0    -$2a            A1           A2
  128.  
  129.                               struct SV_GfxBuffer **dest,
  130.                               A3
  131.  
  132.                               APTR future);
  133.                               D1
  134.  
  135.  
  136.    FUNCTION
  137.  
  138.         handle   = SVP_AllocHandle(N);
  139.         sverr    = SVP_DoOperation( ... );
  140.                    SVP_FreeHandle(handle);
  141.  
  142.         This function allows to do a specific operation on a given
  143.         SV_GfxBuffer.
  144.  
  145.         The Source buffer is not touched this way, but a new buffer will
  146.         be allocated instead.
  147.         The pointer of the new buffer is returned by writing it to a given
  148.         pointer variable.
  149.  
  150.    INPUT(S)
  151.  
  152.         handle   - a valid handle
  153.         source   - a SV_GfxBuffer to be used as "source"
  154.         dest     - a pointer to a pointer for the "destination" SV_GfxBuffer
  155.         future   - always NULL yet
  156.  
  157.    RESULT
  158.  
  159.         NULL or an adequate SVERR-Errorcode.
  160.  
  161.    SINCE
  162.  
  163.         ... Version 1 SVOperators.
  164.  
  165.    SEE ALSO
  166.  
  167.         SVP_AllocHandle(), SVP_FreeHandle()
  168.  
  169. -----------------------------------------------------------------------------
  170.